org.springframework.http.server.reactive

Class UndertowServerHttpResponse

java.lang.Object

org.springframework.http.server.reactive.AbstractServerHttpResponse

org.springframework.http.server.reactive.AbstractListenerServerHttpResponse

org.springframework.http.server.reactive.UndertowServerHttpResponse

All Implemented Interfaces:

HttpMessage, ReactiveHttpOutputMessage, ServerHttpResponse, ZeroCopyHttpOutputMessage

class UndertowServerHttpResponse
extends AbstractListenerServerHttpResponse
implements ZeroCopyHttpOutputMessage

Adapt ServerHttpResponse to the Undertow HttpServerExchange.

Since:

5.0

Author:

Marek Hawrylczak, Rossen Stoyanchev, Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	UndertowServerHttpResponse.ResponseBodyFlushProcessor
private class	UndertowServerHttpResponse.ResponseBodyProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private HttpServerExchange	exchange
private StreamSinkChannel	responseChannel

Constructor Summary

Constructors

Constructor and Description
UndertowServerHttpResponse(HttpServerExchange exchange, DataBufferFactory bufferFactory)

Method Summary

Modifier and Type	Method and Description
protected void	applyCookies() Add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response.
protected void	applyHeaders() Apply header changes from AbstractServerHttpResponse.getHeaders() to the underlying response.
protected void	applyStatusCode() Write the status code to the underlying response.
protected <any>	createBodyFlushProcessor() Abstract template method to create a Processor<Publisher<DataBuffer>, Void> that will write the response body with flushes to the underlying output.
private UndertowServerHttpResponse.ResponseBodyProcessor	createBodyProcessor()
<T> T	getNativeResponse() Return the underlying server response.
<any>	writeWith(java.io.File file, long position, long count) Use the given File to write the body of the message to the underlying HTTP layer.

Methods inherited from class org.springframework.http.server.reactive.AbstractListenerServerHttpResponse

writeAndFlushWithInternal, writeWithInternal

Methods inherited from class org.springframework.http.server.reactive.AbstractServerHttpResponse

addCookie, beforeCommit, bufferFactory, doCommit, doCommit, getCookies, getHeaders, getStatusCode, getStatusCodeValue, isCommitted, setComplete, setStatusCode, setStatusCodeValue, writeAndFlushWith, writeWith

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.http.ReactiveHttpOutputMessage

beforeCommit, bufferFactory, isCommitted, setComplete, writeAndFlushWith, writeWith

Methods inherited from interface org.springframework.http.HttpMessage

getHeaders

Field Detail

exchange

private final HttpServerExchange exchange

responseChannel

@Nullable
private StreamSinkChannel responseChannel

Constructor Detail

UndertowServerHttpResponse

public UndertowServerHttpResponse(HttpServerExchange exchange,
                                  DataBufferFactory bufferFactory)

Method Detail

getNativeResponse

public <T> T getNativeResponse()

Description copied from class: AbstractServerHttpResponse

Return the underlying server response.

Note: This is exposed mainly for internal framework use such as WebSocket upgrades in the spring-webflux module.

Specified by:

getNativeResponse in class AbstractServerHttpResponse

applyStatusCode

protected void applyStatusCode()

Description copied from class: AbstractServerHttpResponse

Write the status code to the underlying response. This method is called once only.

Specified by:

applyStatusCode in class AbstractServerHttpResponse

applyHeaders

protected void applyHeaders()

Description copied from class: AbstractServerHttpResponse

Apply header changes from AbstractServerHttpResponse.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyHeaders in class AbstractServerHttpResponse

applyCookies

protected void applyCookies()

Description copied from class: AbstractServerHttpResponse

Add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyCookies in class AbstractServerHttpResponse

writeWith

public <any> writeWith(java.io.File file,
                       long position,
                       long count)

Description copied from interface: ZeroCopyHttpOutputMessage

Use the given File to write the body of the message to the underlying HTTP layer.

Specified by:

writeWith in interface ZeroCopyHttpOutputMessage

Parameters:

file - the file to transfer

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

Returns:

a publisher that indicates completion or error.

createBodyFlushProcessor

protected <any> createBodyFlushProcessor()

Description copied from class: AbstractListenerServerHttpResponse

Abstract template method to create a Processor<Publisher<DataBuffer>, Void> that will write the response body with flushes to the underlying output. Called from #writeAndFlushWithInternal(Publisher).

Specified by:

createBodyFlushProcessor in class AbstractListenerServerHttpResponse

createBodyProcessor

private UndertowServerHttpResponse.ResponseBodyProcessor createBodyProcessor()